Data Dictionary

Introduction

The Data Dictionary is a feature that stores information about your data.  Information stored in the Data Dictionary includes table and field aliases and joins.  The Data Dictionary is stored in MAPS, but it can be used and edited within Argos using the Argos DataBlock Designer.  Evisions has created several Data Dictionaries that are available for administrators to download from the CO-OP User Community Share at Evisions.com and then import into MAPS.

Managing Data Dictionaries

Data Dictionaries are created and managed by Administrators using the MAPS Configuration Tool.  By selecting Data Dictionary in the left-side Navigation tree, you will gain access to the Data Dictionary configuration screens.  You can create as many separate Data Dictionaries as needed.  For each Data Dictionary, you can define Aliases, Field Joins, Table Joins, Users, and Associated Connections.

Item	Description
Aliases	Field level descriptive names that enable users to more quickly understand the tables and data they are working with and add consistency to your reports and DataBlocks.
Field Joins	Standard single field joins between two tables.
Table Joins	Custom joins between two tables that are not joined on just two fields.  May contain a where clause in the join and is defined using text.
Users	Add users and the rights that they have to this dictionary.
Associated Connections	Data Dictionaries need to be assigned to a connection so that they can be used by the products (Argos) using that connection.

Importing and Exporting Data Dictionaries

Data Dictionary files can be shared using the import and export process.  As stated earlier, Evisions has created several Data Dictionaries that are stored in the CO-OP.  Once downloaded, they can be imported into MAPS.  You can also share your Data Dictionaries on the CO-OP using the Publish button.

Using the Data Dictionary in Argos

You will need to make sure "Use Data Dictionary" is enabled. To enable, go to the menu bar on the main Argos screen and click Tools >> Options to launch the options dialog. On the Query Designer tab, make sure that "Use Data Dictionary" is checked.

In the DataBlock Design window shown below, if Use Dictionary is toggled on you will see Alias and Join information displayed, if it exists in the Data Dictionary.  Note:  you need to refresh the tables to view alias information on existing queries.

Note in the figure above that joins imported from the Data Dictionary are shown with green lines connecting the database tables (as opposed to blue lines when joins are explicitly created by the user).

Adding Aliases to the Dictionary from within Argos

Depending upon the user permissions, suggestions and contributions can be made to the Data Dictionary using the Edit Table dialog box.  Simply add aliases and descriptions to the selected field and contribute your entry.

Users can contribute to the Data Dictionary by submitting alias and join information from within the Visual Query Builder by clicking the Contribute button in the Edit Table dialog or the Edit Join dialog.  Depending upon permissions, information may be submitted as a suggestion which can then be reviewed by an administrator.  The administrator can then change the suggestion to a contribution.

Only items in the Data Dictionary with Contributions  status will be visible within Argos. 

Adding Joins from within Argos

Adding joins to the Data Dictionary is also straightforward.  Click the Add Join button on the toolbar, choose the type of join and then enter the details.  The join is a standard single field join between two tables.  Don’t forget to specify the type of join (inner, left, or right).

If the join is more complex or you prefer to type it yourself, you can use a text join.  Select the tables and then enter the necessary text for your join.  Both join types can be contributed to the Data Dictionary.  

Alias and Join Info Applied to Query

If a Data Dictionary is in use and aliases are present, when a field is added to the query, the alias and description will be added as well.

SELECT Employees.emp_id AS Employee Number,
Employees.last_name AS Employee last name,
Employees.first_name AS Employee first name,
Orders.sale_date
FROM Employees inner join Orders on Employees.emp_id = Orders.employee_id